Operation PDF.WatermarkWithText (PDF: Watermark with Text)

In component org.nuxeo.ecm.platform.pdf.operations

Description

Return a new blob combining the input PDF and the text text.

Properties must be one or more of the following (the default if the property is not set):

fontFamily (Helvetica)
fontSize (72)
rotation (0): in counterclockwise degrees
hex255Color (#000000)
alphaColor (0.5) : 0 is full transparency, 1 is solid
xPosition (0) : in pixels from left or between 0 (left) and 1 (right) if relativeCoordinates is set to true
yPosition (0) : in pixels from bottom or between 0 (bottom) and 1 (top) if relativeCoordinates is set to true
invertX (false) : xPosition starts from the right going left
invertY (false) : yPosition starts from the top going down
relativeCoordinates (false)

Operation id	PDF.WatermarkWithText
Category	Conversion
Label	PDF: Watermark with Text
Requires
Since

Parameters

Name	Description	Type	Required	Default value
text	The text to use for the watermark	string	yes
properties	The watermark properties	properties	no

Signature

Inputs	blob, bloblist
Outputs	blob, bloblist

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.platform.pdf.operations.PDFWatermarkTextOperation
Contributing Component	org.nuxeo.ecm.platform.pdf.operations

JSON Definition

{
  "id" : "PDF.WatermarkWithText",
  "label" : "PDF: Watermark with Text",
  "category" : "Conversion",
  "requires" : null,
  "description" : "<p>Return a <em>new</em> blob combining the input PDF and the <code>text</code> text.</p><p>Properties must be one or more of the following (the default if the property is not set):</p><ul><li><code>fontFamily</code> (Helvetica) </li><li><code>fontSize</code> (72)</li><li><code>rotation</code> (0): in&nbsp;counterclockwise degrees</li><li><code>hex255Color</code> (#000000)</li><li><code>alphaColor</code> (0.5) : 0 is full transparency, 1 is solid</li><li><code>xPosition</code> (0) : in pixels from left or between 0 (left) and 1 (right) if relativeCoordinates is set to true</li><li><code>yPosition</code> (0) : in pixels from bottom or between 0 (bottom) and 1 (top) if relativeCoordinates is set to true</li><li><code>invertX</code> (false) : xPosition starts from the right going left</li><li><code>invertY</code> (false) : yPosition starts from the top going down</li><li><code>relativeCoordinates</code> (false)</li></ul>",
  "url" : "PDF.WatermarkWithText",
  "signature" : [ "blob", "blob", "bloblist", "bloblist" ],
  "params" : [ {
    "name" : "text",
    "description" : "The text to use for the watermark",
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "properties",
    "description" : "The watermark properties",
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}